學習資源

Learn-Git-in-30-days

https://github.com/doggy8088/Learn-Git-in-30-days/tree/master/docs


Jim Huang / 2015年嵌入式系統課程

[Week #2] 常見學生作業繳交的缺失,如下:

  • 英文表達能力不足 : 無法在 Git commit messages 中簡潔扼要地說明自己的修改
  • Git commit messages
第一行應該要摘要該次修改的目的,第二行直接換行,而在第三行以後才詳細闡述
  • 混合兩項 (或以上) 不相關的修改,到單一 Git commit 中:
像是一個 Git commit 中包含 C 程式語法調整以及 Assembly 指令的修改
  • 將生成的檔案,如 ELF 執行檔,放進 Git repository

  • 恣意修改程式碼編排 (coding style):

工程領域絕大多數的機會都站在既有基礎上開發,
也就是不時要和許多人合作,倘若因為「我覺得現有編排風格不好」
卻在沒有充分和其他人溝通 (至少得和我討論)
的狀況下,貿然改變編排風格,該怎麼有效合作呢?

魔鬼總在細節裡,專業就是從小處開始。

你如何評估一個開發者的程式碼是否專業?除了看程式碼,
很多時候我們會直接調閱 git log的訊息,
從開發歷程、開發者所想表達的想法,以及如何攻克一個又一個
的技術挑戰,去理解該開發者的涵養。
反過來想,如果我們看到一個專案的 git log 
充斥著 "Update ..."這種言不及義的訊息,
連程式碼在作什麼都交待不清,還有只會用小學生等級的英文詞彙,
到底要怎麼向人證明有專業可言?

參考:git 50/72 format

第一行是50 字的簡要說明,第二行空白,之後是補充說明限制在一行72 字內

http://stackoverflow.com/questions/2290016/git-commit-messages-50-72-formatting

results matching ""

    No results matching ""